Primitive Class Flow.LensFlare
Represents a global lens flare (not to be confused with the lens flare object).
Functions
| LensFlare(pitch, yaw, color) | Create a LensFlare object. |
| LensFlare:GetSunSpriteID() | Get this lens flare's sun sprite ID. |
| LensFlare:GetPitch() | Get this lens flare's pitch angle in degrees. |
| LensFlare:GetYaw() | Get this lens flare's yaw angle in degrees. |
| LensFlare:GetColor() | Get the lens flare's color. |
| LensFlare:GetEnabled() | Get this lens flare's enabled status. |
| LensFlare:SetSunSpriteID(spriteID) | Set this lens flare's sun sprite ID. |
| LensFlare:SetPitch(pitch) | Set this lens flare's pitch angle. |
| LensFlare:SetYaw(yaw) | Set this lens flare's yaw angle. |
| LensFlare:SetColor(color) | Set this lens flare's color. |
Functions
- LensFlare(pitch, yaw, color)
-
Create a LensFlare object.
Parameters:
- pitch float Pitch angle in degrees.
- yaw float Yaw angle in degrees.
- color Color Color of the lensflare.
Returns:
-
LensFlare
A new LensFlare object.
- LensFlare:GetSunSpriteID()
-
Get this lens flare's sun sprite ID.
Returns:
-
int
Sprite ID.
- LensFlare:GetPitch()
-
Get this lens flare's pitch angle in degrees.
Returns:
-
float
Pitch angle in degrees.
- LensFlare:GetYaw()
-
Get this lens flare's yaw angle in degrees.
Returns:
-
float
Yaw angle in degrees.
- LensFlare:GetColor()
- Get the lens flare's color.
- LensFlare:GetEnabled()
-
Get this lens flare's enabled status.
Returns:
-
bool
Enabled status. true: enabled, false: disabled
- LensFlare:SetSunSpriteID(spriteID)
-
Set this lens flare's sun sprite ID.
Parameters:
- spriteID int New sun sprite ID.
- LensFlare:SetPitch(pitch)
-
Set this lens flare's pitch angle.
Parameters:
- pitch float New pitch angle in degrees.
- LensFlare:SetYaw(yaw)
-
Set this lens flare's yaw angle.
Parameters:
- yaw float New yaw angle in degrees.
- LensFlare:SetColor(color)
-
Set this lens flare's color.
Parameters:
- color Color New color.